Skip to content

Bender Book#295

Open
fischeti wants to merge 47 commits into
masterfrom
book
Open

Bender Book#295
fischeti wants to merge 47 commits into
masterfrom
book

Conversation

@fischeti
Copy link
Copy Markdown
Contributor

@fischeti fischeti commented Mar 30, 2026

TODOs

  • Change structure maybe? Put book.toml in root directory
  • Figure out how to deploy to GH pages in a nice way (Github artifacts)
  • Align Mention in installer: replace init with version-aware router #285, remove website branch
  • Figure out what to do with commands section
  • Remove sources workflow?
  • Shorten README significantly and refer to the book
  • Change pages deployment: Settings -> Pages -> Source: change from website to "Github Actions"

@micprog
Copy link
Copy Markdown
Member

micprog commented Apr 16, 2026

@fischeti Does this already include the bender install script (and possibly updates from #285)? If we change the pointer from branch to pages, then the install script is no longer available (if I'm not mistaken). If possible, I'd like to ensure continuity on that front.

@fischeti
Copy link
Copy Markdown
Contributor Author

No not yet. You are right, we should merge both of them at the same time. Let me rebase #285 onto this branch. Then we can merge it in here and push both book and new install scripts at once.

@micprog
Copy link
Copy Markdown
Member

micprog commented Apr 16, 2026

No not yet. You are right, we should merge both of them at the same time. Let me rebase #285 onto this branch. Then we can merge it in here and push both book and new install scripts at once.

I see the website/init file in the diff now, while reviewing. It exists and looks to be placed in the correct spot, but it is still the old version. We will have to figure out how to get latest working correctly only once 0.32.0 is released, but I think we can manage.

@fischeti
Copy link
Copy Markdown
Contributor Author

ah, right. I forgot that I also added it here already. This means this PR is independent from #285 and should not break anything regarding the installation script.

Copy link
Copy Markdown
Member

@micprog micprog left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think there are some points to address... I have not checked the README (I want to ensure all content previously covered within is properly covered in the book) and the commands (I want to ensure all are present), but figured I'd share the comments I already have.

Comment thread book/.gitignore Outdated
Comment thread book/src/workflows.md Outdated
Comment thread book/src/workflows.md
Comment thread .github/workflows/docs.yml
Comment thread book/src/workflow/ci.md Outdated
Comment thread book/src/workflow/package_dev.md Outdated
Comment thread book/src/workflow/scripts.md Outdated
Comment thread book/src/workflow/scripts.md
Comment thread book/src/workflow/vendor.md Outdated
Comment thread book/src/workflow/vendor.md
Copy link
Copy Markdown
Member

@micprog micprog left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM now 👍

We can figure out how to handle the init script in #285

fischeti and others added 29 commits May 19, 2026 13:29
Co-authored-by: Michael Rogenmoser <michael@rogenmoser.us>

Update book/src/workflow/ci.md

Co-authored-by: Michael Rogenmoser <michael@rogenmoser.us>

Update book/src/workflow/dependencies.md

Co-authored-by: Michael Rogenmoser <michael@rogenmoser.us>

Update book/src/workflow/package_dev.md

Co-authored-by: Michael Rogenmoser <michael@rogenmoser.us>

Update book/src/workflow/scripts.md

Co-authored-by: Michael Rogenmoser <michael@rogenmoser.us>

Update book/src/workflow/dependencies.md

Co-authored-by: Michael Rogenmoser <michael@rogenmoser.us>

Update book/src/workflow/dependencies.md

Co-authored-by: Michael Rogenmoser <michael@rogenmoser.us>

Update book/src/workflow/dependencies.md

Co-authored-by: Michael Rogenmoser <michael@rogenmoser.us>

Update book/src/dependencies.md

Co-authored-by: Michael Rogenmoser <michael@rogenmoser.us>

Update book/src/index.md

Co-authored-by: Michael Rogenmoser <michael@rogenmoser.us>

Update book/src/local.md

Co-authored-by: Michael Rogenmoser <michael@rogenmoser.us>

Update book/src/manifest.md

Co-authored-by: Michael Rogenmoser <michael@rogenmoser.us>

Update book/src/principles.md

Co-authored-by: Michael Rogenmoser <michael@rogenmoser.us>

Update book/src/targets.md

Co-authored-by: Michael Rogenmoser <michael@rogenmoser.us>
Replace the Linux-only "Linux Distributions" subsection with a broader
"Package Managers" section covering the existing Homebrew formula, the
nixpkgs package and the repo's own flake, and the AUR package.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Tweak principles to avoid enumerating EDA tools, note that Bender.yml
should sit at the Git repo root, clarify group-level include_dirs
scope, document `bender script template_json`, link directly to the
lowRISC `vendor.py`, and call out that vendored files still need to be
listed under `sources`.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Restore details that were present in the pre-book README but not yet in
the rendered book: full `bender pickle` subcommand reference, concrete
Git LFS warning codes (W26/W27), the rule that dependency target
filters do not affect lockfile resolution, target-conditional
`include_dirs` and `defines` syntax, recommended `test`/`rtl`/`gate`
target conventions, the deprecation status of `plugins` in the
configuration file, and a link to the Cargo dependency-spec reference
alongside the existing semver crate link.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Drop the marketing-style "Decentralized and Secure" / "Local-First
Development" framings and the four-principle expansion. Restore the
original README structure of two core principles ("be as opt-in as
possible", "allow for reproducible builds") followed by the three
feature tiers, with the NDA / private-repo motivation folded back into
the dependency-management tier where it originally lived.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Fix factual errors, fill in missing flag documentation, inline warning
code references where the relevant feature is documented, and tighten
prose:

- lockfile.md: move `frozen: true` out of the `package` block in the
  example; it's a top-level manifest field.
- commands.md: rewrite `pickle` Slang-availability note to use the
  correct feature flag (`--features slang`, not `--all-features`),
  and reword the colloquial `bender update` note.
- concepts.md: rename `local.md` TOC entry from "Workspace" to
  "Local Configuration" to match the page title.
- commands.md: document `path --checkout`, `packages --version` /
  `--targets`, `sources --raw` / `--ignore-passed-targets`, and
  `parents --targets`; add cross-links from `sources` to
  dependencies.md / sources.md and from manifest plugins to commands.md.
- workflow/dependencies.md: document `audit --ignore-url-conflict`.
- workflow/package_dev.md: document snapshot `--working-dir`,
  `--checkout`, `--force`, including the W25 interaction with
  `--no-skip`.
- Inline warning codes where the related feature is documented:
  W01/W06 under workspace fields, W11 under `upstream_name`, W14 under
  `--local`, W18 under overrides, W25 under snapshot.
- Drop "powerful" filler from index.md, targets.md, sources.md.
- Add missing cross-links from getting_started.md and index.md.
- Standardize "tapeout" -> "tape-out".

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants